<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>v_voip_packetizer56: xpacketizer56.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">v_voip_packetizer56
   </div>
   <div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xpacketizer56_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xpacketizer56.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This is the main header file for VoIP ST2022-6 Packetizer core. </p>
<p>VoIP ST2022-6 Packetizer core is used for Packetized incoming SDI to AXI4-Stream in to ST2022-6 compliant RTP Packet</p>
<p>The VoIP ST2022-6 Packetizer has 3 main Interface</p><ul>
<li>AXI4-Stream Interface for accepting Incoming SDI to AXI4-Stream Packet</li>
<li>AXI4-Stream Interface for transmitting RTP Packet &lt;RTP Header | Payload&gt;</li>
<li>AXI4-Lite interface for processor, controls the VoIP ST2022-6 Packetizer.</li>
</ul>
<p>VoIP ST2022-6 Packetizer Performs Following Operation</p><ul>
<li>Packetized SDI to AXI4-Stream Packet into ST2022-6 RTP Packet</li>
<li>Add user configured RTP Header into RTP Packet Header</li>
</ul>
<p><b>Software Initialization &amp; Configuration</b></p>
<p>The application needs to do following steps in order for preparing the VoIP ST2022-6 Packetizer core to be ready.</p>
<ul>
<li>Call XPacketizer56_LookupConfig using a device ID to find the core configuration.</li>
<li>Call XPacketizer56_CfgInitialize to initialize the device and the driver instance associated with it.</li>
</ul>
<p>This driver provides interrupt handlers</p><ul>
<li>XPacketizer56_IntrHandler, for handling the interrupts from the VoIP ST2022-6 Packetizer core</li>
</ul>
<p>Application developer needs to register interrupt handler with the processor, within their examples. Whenever processor calls registered application's interrupt handler associated with interrupt id, application's interrupt handler needs to call appropriate peripheral interrupt handler reading peripherals Status register.</p>
<p>This driver provides XPacketizer56_SetCallback API to register functions with VoIP ST2022-6 Packetizer core instance.</p>
<p><b> Virtual Memory </b></p>
<p><b> Threads </b></p>
<p><b> Asserts </b></p>
<p><b> Building the driver </b></p>
<p>The VoIP ST2022-6 Packetizer driver is composed of several source files. This allows the user to build and link only those parts of the driver that are necessary.</p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who    Date     Changes
<hr/>

1.00   mmo   02/12/16 Initial release.</pre><pre></pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_packetizer56___config.html">XPacketizer56_Config</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This typedef contains configuration information for the VoIP ST2022-6 Packetizer core.  <a href="struct_x_packetizer56___config.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_packetizer56___stream.html">XPacketizer56_Stream</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This typedef contains Incoming SDI to AXI4-Stream Information.  <a href="struct_x_packetizer56___stream.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_packetizer56___module_statistic.html">XPacketizer56_ModuleStatistic</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This typedef contains Incoming Frame Count and Outgoing Packet Count Information.  <a href="struct_x_packetizer56___module_statistic.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_packetizer56.html">XPacketizer56</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The VoIP ST2022-6 Packetizer driver instance data.  <a href="struct_x_packetizer56.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ae8c701f4baf93f49227bd4a237aa4a30"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xpacketizer56_8h.html#ae8c701f4baf93f49227bd4a237aa4a30">XPACKETIZER56_H_</a></td></tr>
<tr class="memdesc:ae8c701f4baf93f49227bd4a237aa4a30"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prevent circular inclusions by using protection macros.  <a href="#ae8c701f4baf93f49227bd4a237aa4a30">More...</a><br /></td></tr>
<tr class="separator:ae8c701f4baf93f49227bd4a237aa4a30"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a579ad9343a247e1f686a885b0f3e6f39"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xpacketizer56_8h.html#a579ad9343a247e1f686a885b0f3e6f39">XPacketizer56_Callback</a>) (void *CallbackRef)</td></tr>
<tr class="memdesc:a579ad9343a247e1f686a885b0f3e6f39"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback type for VoIP ST2022-6 Packetizer event interrupt.  <a href="#a579ad9343a247e1f686a885b0f3e6f39">More...</a><br /></td></tr>
<tr class="separator:a579ad9343a247e1f686a885b0f3e6f39"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Handler Types</div></td></tr>
<tr class="memitem:abf9d1385746f90dfa560788deb9a3d65"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xpacketizer56_8h.html#abf9d1385746f90dfa560788deb9a3d65">XPacketizer56_HandlerType</a> <tr class="memdesc:abf9d1385746f90dfa560788deb9a3d65"><td class="mdescLeft">&#160;</td><td class="mdescRight">These constants specify different types of handler and used to differentiate interrupt requests from peripheral.  <a href="xpacketizer56_8h.html#abf9d1385746f90dfa560788deb9a3d65">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:abf9d1385746f90dfa560788deb9a3d65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Timestamp Reference (Video Header)</div></td></tr>
<tr class="memitem:a0d9e6d76323efc102eabc6991b603708"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xpacketizer56_8h.html#a0d9e6d76323efc102eabc6991b603708">XPacketizer56_TimestampRef</a> <tr class="memdesc:a0d9e6d76323efc102eabc6991b603708"><td class="mdescLeft">&#160;</td><td class="mdescRight">These constants specify specify the VoIP ST2022-6 Packetizer Timestamp Reference in the Video Header.  <a href="xpacketizer56_8h.html#a0d9e6d76323efc102eabc6991b603708">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a0d9e6d76323efc102eabc6991b603708"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Video Bit Rate</div></td></tr>
<tr class="memitem:a6597366a23f46b2c863def5179cdfd73"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xpacketizer56_8h.html#a6597366a23f46b2c863def5179cdfd73">XPacketizer56_RXBITRATE</a> <tr class="memdesc:a6597366a23f46b2c863def5179cdfd73"><td class="mdescLeft">&#160;</td><td class="mdescRight">These constants specify specify the VoIP ST2022-6 Packetizer Video Bit Rate either is an Integer (148.5 MHz or 74.25 MHz) or Non-Integer (148.35 MHz or 74.175 MHz)  <a href="xpacketizer56_8h.html#a6597366a23f46b2c863def5179cdfd73">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a6597366a23f46b2c863def5179cdfd73"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">3G-SDI Level</div></td></tr>
<tr class="memitem:acd0ce4e7cdee2243a6ca5d89a2a90c67"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xpacketizer56_8h.html#acd0ce4e7cdee2243a6ca5d89a2a90c67">XPacketizer56_3G_LEVEL</a> <tr class="memdesc:acd0ce4e7cdee2243a6ca5d89a2a90c67"><td class="mdescLeft">&#160;</td><td class="mdescRight">These constants specify specify the VoIP ST2022-6 Packetizer Incoming SDI to AXI4-Stream is a SDI-3G Level A or Level B.  <a href="xpacketizer56_8h.html#acd0ce4e7cdee2243a6ca5d89a2a90c67">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:acd0ce4e7cdee2243a6ca5d89a2a90c67"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">SDI Mode</div></td></tr>
<tr class="memitem:a36f81b4bc607590c33e0c720e286715f"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xpacketizer56_8h.html#a36f81b4bc607590c33e0c720e286715f">XPacketizer56_SDIMode</a> <tr class="memdesc:a36f81b4bc607590c33e0c720e286715f"><td class="mdescLeft">&#160;</td><td class="mdescRight">These constants specify specify the VoIP ST2022-6 Packetizer Incoming SDI to AXI4-Stream SDI Mode, SD-SDI or HD-SDI or 3G-SDI.  <a href="xpacketizer56_8h.html#a36f81b4bc607590c33e0c720e286715f">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a36f81b4bc607590c33e0c720e286715f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">ST2022-6 Packetizer Module Enable/Disable</div></td></tr>
<tr class="memitem:adb1f6dcad7ecb27ce6a894659b7f741c"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xpacketizer56_8h.html#adb1f6dcad7ecb27ce6a894659b7f741c">XPacketizer56_ModEn</a> <tr class="memdesc:adb1f6dcad7ecb27ce6a894659b7f741c"><td class="mdescLeft">&#160;</td><td class="mdescRight">These constants specify specify the VoIP ST2022-6 Packetizer Module Enable or Disable.  <a href="xpacketizer56_8h.html#adb1f6dcad7ecb27ce6a894659b7f741c">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:adb1f6dcad7ecb27ce6a894659b7f741c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">ST2022-6 Packetizer Operating Mode</div></td></tr>
<tr class="memitem:a0d85236c2569a74fab652c902caf18b6"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xpacketizer56_8h.html#a0d85236c2569a74fab652c902caf18b6">XPacketizer56_LosslessMode</a> <tr class="memdesc:a0d85236c2569a74fab652c902caf18b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">These constants specify specify the VoIP ST2022-6 Packetizer Operating Mode, Normal Mode or Lossless Mode.  <a href="xpacketizer56_8h.html#a0d85236c2569a74fab652c902caf18b6">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a0d85236c2569a74fab652c902caf18b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a1f79747e14aa02976304116219091964"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_packetizer56___config.html">XPacketizer56_Config</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xpacketizer56_8h.html#a1f79747e14aa02976304116219091964">XPacketizer56_LookupConfig</a> (u16 DeviceId)</td></tr>
<tr class="memdesc:a1f79747e14aa02976304116219091964"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns a reference to an <a class="el" href="struct_x_packetizer56___config.html" title="This typedef contains configuration information for the VoIP ST2022-6 Packetizer core. ">XPacketizer56_Config</a> structure based on the core id, <em>DeviceId</em>.  <a href="#a1f79747e14aa02976304116219091964">More...</a><br /></td></tr>
<tr class="separator:a1f79747e14aa02976304116219091964"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2916ab3ad24967e5c1bbad5d2385060d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xpacketizer56_8h.html#a2916ab3ad24967e5c1bbad5d2385060d">XPacketizer56_CfgInitialize</a> (<a class="el" href="struct_x_packetizer56.html">XPacketizer56</a> *InstancePtr, <a class="el" href="struct_x_packetizer56___config.html">XPacketizer56_Config</a> *CfgPtr, UINTPTR EffectiveAddr)</td></tr>
<tr class="memdesc:a2916ab3ad24967e5c1bbad5d2385060d"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function initializes the VoIP ST2022-6 Packetizer core.  <a href="#a2916ab3ad24967e5c1bbad5d2385060d">More...</a><br /></td></tr>
<tr class="separator:a2916ab3ad24967e5c1bbad5d2385060d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1f5a88f99605ba14c1109c3e8f79c6c3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xpacketizer56_8h.html#a1f5a88f99605ba14c1109c3e8f79c6c3">XPacketizer56_IntrHandler</a> (void *InstancePtr)</td></tr>
<tr class="memdesc:a1f5a88f99605ba14c1109c3e8f79c6c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is the interrupt handler for the VoIP ST2022-6 Packetizer driver.  <a href="#a1f5a88f99605ba14c1109c3e8f79c6c3">More...</a><br /></td></tr>
<tr class="separator:a1f5a88f99605ba14c1109c3e8f79c6c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af872f7a0af19ac04acfae5b55ca6a5e5"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xpacketizer56_8h.html#af872f7a0af19ac04acfae5b55ca6a5e5">XPacketizer56_SetCallback</a> (<a class="el" href="struct_x_packetizer56.html">XPacketizer56</a> *InstancePtr, <a class="el" href="xpacketizer56_8h.html#abf9d1385746f90dfa560788deb9a3d65">XPacketizer56_HandlerType</a> HandlerType, void *CallbackFunc, void *CallbackRef)</td></tr>
<tr class="memdesc:af872f7a0af19ac04acfae5b55ca6a5e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function installs an asynchronous callback function for the given HandlerType:  <a href="#af872f7a0af19ac04acfae5b55ca6a5e5">More...</a><br /></td></tr>
<tr class="separator:af872f7a0af19ac04acfae5b55ca6a5e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a40096cb653e9cb986cd75861615ee498"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_packetizer56___stream.html">XPacketizer56_Stream</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xpacketizer56_8h.html#a40096cb653e9cb986cd75861615ee498">XPacketizer56_MediaDatagramInfo</a> (<a class="el" href="struct_x_packetizer56.html">XPacketizer56</a> *InstancePtr)</td></tr>
<tr class="memdesc:a40096cb653e9cb986cd75861615ee498"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function Writes the RTP-Media Header into the VoIP ST2022-6 Register.  <a href="#a40096cb653e9cb986cd75861615ee498">More...</a><br /></td></tr>
<tr class="separator:a40096cb653e9cb986cd75861615ee498"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace2806d4f7a35215a664af06e5c1f8e1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xpacketizer56_8h.html#ace2806d4f7a35215a664af06e5c1f8e1">XPacketizer56_ModEnable</a> (<a class="el" href="struct_x_packetizer56.html">XPacketizer56</a> *InstancePtr)</td></tr>
<tr class="memdesc:ace2806d4f7a35215a664af06e5c1f8e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function Enable or Disable the Module based on User Configured Structure of ModuleEnable.  <a href="#ace2806d4f7a35215a664af06e5c1f8e1">More...</a><br /></td></tr>
<tr class="separator:ace2806d4f7a35215a664af06e5c1f8e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a17e88608f036d1359cc6a479bf643198"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xpacketizer56_8h.html#a17e88608f036d1359cc6a479bf643198">XPacketizer56_LosslessEnable</a> (<a class="el" href="struct_x_packetizer56.html">XPacketizer56</a> *InstancePtr)</td></tr>
<tr class="memdesc:a17e88608f036d1359cc6a479bf643198"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function Sets the Operating Mode based on User Configure Value in VoIP ST2022-6 Packetizer Structure of LoslessMode LoslessMode : XPACKETIZER56_NORMAL : Normal Mode XPACKETIZER56_LOSSLESS : Lossless Mode.  <a href="#a17e88608f036d1359cc6a479bf643198">More...</a><br /></td></tr>
<tr class="separator:a17e88608f036d1359cc6a479bf643198"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a39b9dab89e94f61594d6ff66fdc58423"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xpacketizer56_8h.html#a39b9dab89e94f61594d6ff66fdc58423">XPacketizer56_RegClear</a> (<a class="el" href="struct_x_packetizer56.html">XPacketizer56</a> *InstancePtr)</td></tr>
<tr class="memdesc:a39b9dab89e94f61594d6ff66fdc58423"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function Clears all the VoIP ST2022-6 Packetizer Register Space.  <a href="#a39b9dab89e94f61594d6ff66fdc58423">More...</a><br /></td></tr>
<tr class="separator:a39b9dab89e94f61594d6ff66fdc58423"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a94745146086a37969cb0853f2bf0ba2f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xpacketizer56_8h.html#a94745146086a37969cb0853f2bf0ba2f">XPacketizer56_VidFormat</a> (<a class="el" href="struct_x_packetizer56.html">XPacketizer56</a> *InstancePtr)</td></tr>
<tr class="memdesc:a94745146086a37969cb0853f2bf0ba2f"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function Writes the Video Format into the VoIP ST2022-6 Register.  <a href="#a94745146086a37969cb0853f2bf0ba2f">More...</a><br /></td></tr>
<tr class="separator:a94745146086a37969cb0853f2bf0ba2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a089d9267ab16154df6e0bf8f598db671"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xpacketizer56_8h.html#a089d9267ab16154df6e0bf8f598db671">XPacketizer56_RTPMediaHeader</a> (<a class="el" href="struct_x_packetizer56.html">XPacketizer56</a> *InstancePtr)</td></tr>
<tr class="memdesc:a089d9267ab16154df6e0bf8f598db671"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function Writes the RTP-Media Header into the VoIP ST2022-6 Register.  <a href="#a089d9267ab16154df6e0bf8f598db671">More...</a><br /></td></tr>
<tr class="separator:a089d9267ab16154df6e0bf8f598db671"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb006d8aed47ede27b6f13590ca7cffa"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xpacketizer56_8h.html#abb006d8aed47ede27b6f13590ca7cffa">XPacketizer56_SetChannel</a> (<a class="el" href="struct_x_packetizer56.html">XPacketizer56</a> *InstancePtr)</td></tr>
<tr class="memdesc:abb006d8aed47ede27b6f13590ca7cffa"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function Sets the Channel Number Information which will be added in to TUSER Master AXI4-Stream of the Module.  <a href="#abb006d8aed47ede27b6f13590ca7cffa">More...</a><br /></td></tr>
<tr class="separator:abb006d8aed47ede27b6f13590ca7cffa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac24d2370200ddf0cd2efdef54be18952"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xpacketizer56_8h.html#ac24d2370200ddf0cd2efdef54be18952">XPacketizer56_SetSSRC</a> (<a class="el" href="struct_x_packetizer56.html">XPacketizer56</a> *InstancePtr)</td></tr>
<tr class="memdesc:ac24d2370200ddf0cd2efdef54be18952"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function Sets the RTP-SSRC Header.  <a href="#ac24d2370200ddf0cd2efdef54be18952">More...</a><br /></td></tr>
<tr class="separator:ac24d2370200ddf0cd2efdef54be18952"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ae8c701f4baf93f49227bd4a237aa4a30"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae8c701f4baf93f49227bd4a237aa4a30">&#9670;&nbsp;</a></span>XPACKETIZER56_H_</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XPACKETIZER56_H_</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Prevent circular inclusions by using protection macros. </p>

</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="a579ad9343a247e1f686a885b0f3e6f39"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a579ad9343a247e1f686a885b0f3e6f39">&#9670;&nbsp;</a></span>XPacketizer56_Callback</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef void(* XPacketizer56_Callback) (void *CallbackRef)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Callback type for VoIP ST2022-6 Packetizer event interrupt. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">CallbackRef</td><td>is a callback reference passed in by the upper layer when setting the callback functions, and passed back to the upper layer when the callback is invoked.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="acd0ce4e7cdee2243a6ca5d89a2a90c67"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd0ce4e7cdee2243a6ca5d89a2a90c67">&#9670;&nbsp;</a></span>XPacketizer56_3G_LEVEL</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="xpacketizer56_8h.html#acd0ce4e7cdee2243a6ca5d89a2a90c67">XPacketizer56_3G_LEVEL</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>These constants specify specify the VoIP ST2022-6 Packetizer Incoming SDI to AXI4-Stream is a SDI-3G Level A or Level B. </p>

</div>
</div>
<a id="abf9d1385746f90dfa560788deb9a3d65"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abf9d1385746f90dfa560788deb9a3d65">&#9670;&nbsp;</a></span>XPacketizer56_HandlerType</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="xpacketizer56_8h.html#abf9d1385746f90dfa560788deb9a3d65">XPacketizer56_HandlerType</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>These constants specify different types of handler and used to differentiate interrupt requests from peripheral. </p>

</div>
</div>
<a id="a0d85236c2569a74fab652c902caf18b6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0d85236c2569a74fab652c902caf18b6">&#9670;&nbsp;</a></span>XPacketizer56_LosslessMode</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="xpacketizer56_8h.html#a0d85236c2569a74fab652c902caf18b6">XPacketizer56_LosslessMode</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>These constants specify specify the VoIP ST2022-6 Packetizer Operating Mode, Normal Mode or Lossless Mode. </p>

</div>
</div>
<a id="adb1f6dcad7ecb27ce6a894659b7f741c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adb1f6dcad7ecb27ce6a894659b7f741c">&#9670;&nbsp;</a></span>XPacketizer56_ModEn</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="xpacketizer56_8h.html#adb1f6dcad7ecb27ce6a894659b7f741c">XPacketizer56_ModEn</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>These constants specify specify the VoIP ST2022-6 Packetizer Module Enable or Disable. </p>

</div>
</div>
<a id="a6597366a23f46b2c863def5179cdfd73"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6597366a23f46b2c863def5179cdfd73">&#9670;&nbsp;</a></span>XPacketizer56_RXBITRATE</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="xpacketizer56_8h.html#a6597366a23f46b2c863def5179cdfd73">XPacketizer56_RXBITRATE</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>These constants specify specify the VoIP ST2022-6 Packetizer Video Bit Rate either is an Integer (148.5 MHz or 74.25 MHz) or Non-Integer (148.35 MHz or 74.175 MHz) </p>

</div>
</div>
<a id="a36f81b4bc607590c33e0c720e286715f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a36f81b4bc607590c33e0c720e286715f">&#9670;&nbsp;</a></span>XPacketizer56_SDIMode</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="xpacketizer56_8h.html#a36f81b4bc607590c33e0c720e286715f">XPacketizer56_SDIMode</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>These constants specify specify the VoIP ST2022-6 Packetizer Incoming SDI to AXI4-Stream SDI Mode, SD-SDI or HD-SDI or 3G-SDI. </p>

</div>
</div>
<a id="a0d9e6d76323efc102eabc6991b603708"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0d9e6d76323efc102eabc6991b603708">&#9670;&nbsp;</a></span>XPacketizer56_TimestampRef</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="xpacketizer56_8h.html#a0d9e6d76323efc102eabc6991b603708">XPacketizer56_TimestampRef</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>These constants specify specify the VoIP ST2022-6 Packetizer Timestamp Reference in the Video Header. </p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a2916ab3ad24967e5c1bbad5d2385060d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2916ab3ad24967e5c1bbad5d2385060d">&#9670;&nbsp;</a></span>XPacketizer56_CfgInitialize()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XPacketizer56_CfgInitialize </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_packetizer56.html">XPacketizer56</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_packetizer56___config.html">XPacketizer56_Config</a> *&#160;</td>
          <td class="paramname"><em>CfgPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">UINTPTR&#160;</td>
          <td class="paramname"><em>EffectiveAddr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function initializes the VoIP ST2022-6 Packetizer core. </p>
<p>This function must be called prior to using the VoIP ST2022-6 Packetizer core. Initialization of the VoIP ST2022-6 Packetizer includes setting up the instance data, and ensuring the hardware is in a quiescent state.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the VoIP ST2022-6 Packetizer core instance. </td></tr>
    <tr><td class="paramname">CfgPtr</td><td>points to the configuration structure associated with the HDMI RX core. </td></tr>
    <tr><td class="paramname">EffectiveAddr</td><td>is the base address of the device. If address translation is being used, then this parameter must reflect the virtual base address. Otherwise, the physical address should be used.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if XPacketizer56_CfgInitialize was successful.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="struct_x_packetizer56.html#a764d994d45e884656a883b8281f5360b">XPacketizer56::DatagramMismatchCallback</a>.</p>

</div>
</div>
<a id="a1f5a88f99605ba14c1109c3e8f79c6c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1f5a88f99605ba14c1109c3e8f79c6c3">&#9670;&nbsp;</a></span>XPacketizer56_IntrHandler()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XPacketizer56_IntrHandler </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is the interrupt handler for the VoIP ST2022-6 Packetizer driver. </p>
<p>This handler reads the pending interrupt from VoIP ST2022-6 Packetizer, determines the source of the interrupts, clears the interrupts and calls callbacks accordingly.</p>
<p>The application is responsible for connecting this function to the interrupt system. Application beyond this driver is also responsible for providing callbacks to handle interrupts and installing the callbacks using <a class="el" href="xpacketizer56__intr_8c.html#af872f7a0af19ac04acfae5b55ca6a5e5" title="This function installs an asynchronous callback function for the given HandlerType: ...">XPacketizer56_SetCallback()</a> during initialization phase. An example delivered with this driver demonstrates how this could be done.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_packetizer56.html" title="The VoIP ST2022-6 Packetizer driver instance data. ">XPacketizer56</a> instance that just interrupted.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="xpacketizer56__hw_8h.html#a28587e6d7339280842f2942b4dac77e3">XPacketizer56_ReadReg</a>.</p>

</div>
</div>
<a id="a1f79747e14aa02976304116219091964"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1f79747e14aa02976304116219091964">&#9670;&nbsp;</a></span>XPacketizer56_LookupConfig()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_packetizer56___config.html">XPacketizer56_Config</a>* XPacketizer56_LookupConfig </td>
          <td>(</td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>DeviceId</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function returns a reference to an <a class="el" href="struct_x_packetizer56___config.html" title="This typedef contains configuration information for the VoIP ST2022-6 Packetizer core. ">XPacketizer56_Config</a> structure based on the core id, <em>DeviceId</em>. </p>
<p>The return value will refer to an entry in the device configuration table defined in the xpacketizer56_g.c file.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">DeviceId</td><td>is the unique core ID of the ST2022-6 Packetizer core for the lookup operation.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XPacketizer56_LookupConfig returns a reference to a config record in the configuration table (in xpacketizer56_g.c) corresponding to <em>DeviceId</em>, or NULL if no match is found.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

</div>
</div>
<a id="a17e88608f036d1359cc6a479bf643198"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17e88608f036d1359cc6a479bf643198">&#9670;&nbsp;</a></span>XPacketizer56_LosslessEnable()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XPacketizer56_LosslessEnable </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_packetizer56.html">XPacketizer56</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function Sets the Operating Mode based on User Configure Value in VoIP ST2022-6 Packetizer Structure of LoslessMode LoslessMode : XPACKETIZER56_NORMAL : Normal Mode XPACKETIZER56_LOSSLESS : Lossless Mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_packetizer56.html" title="The VoIP ST2022-6 Packetizer driver instance data. ">XPacketizer56</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="xpacketizer56__hw_8h.html#a28587e6d7339280842f2942b4dac77e3">XPacketizer56_ReadReg</a>.</p>

</div>
</div>
<a id="a40096cb653e9cb986cd75861615ee498"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a40096cb653e9cb986cd75861615ee498">&#9670;&nbsp;</a></span>XPacketizer56_MediaDatagramInfo()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_packetizer56___stream.html">XPacketizer56_Stream</a> XPacketizer56_MediaDatagramInfo </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_packetizer56.html">XPacketizer56</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function Writes the RTP-Media Header into the VoIP ST2022-6 Register. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_packetizer56.html" title="The VoIP ST2022-6 Packetizer driver instance data. ">XPacketizer56</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

</div>
</div>
<a id="ace2806d4f7a35215a664af06e5c1f8e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace2806d4f7a35215a664af06e5c1f8e1">&#9670;&nbsp;</a></span>XPacketizer56_ModEnable()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XPacketizer56_ModEnable </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_packetizer56.html">XPacketizer56</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function Enable or Disable the Module based on User Configured Structure of ModuleEnable. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_packetizer56.html" title="The VoIP ST2022-6 Packetizer driver instance data. ">XPacketizer56</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="xpacketizer56__hw_8h.html#a28587e6d7339280842f2942b4dac77e3">XPacketizer56_ReadReg</a>.</p>

</div>
</div>
<a id="a39b9dab89e94f61594d6ff66fdc58423"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a39b9dab89e94f61594d6ff66fdc58423">&#9670;&nbsp;</a></span>XPacketizer56_RegClear()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XPacketizer56_RegClear </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_packetizer56.html">XPacketizer56</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function Clears all the VoIP ST2022-6 Packetizer Register Space. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_packetizer56.html" title="The VoIP ST2022-6 Packetizer driver instance data. ">XPacketizer56</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="xpacketizer56__hw_8h.html#a28587e6d7339280842f2942b4dac77e3">XPacketizer56_ReadReg</a>.</p>

</div>
</div>
<a id="a089d9267ab16154df6e0bf8f598db671"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a089d9267ab16154df6e0bf8f598db671">&#9670;&nbsp;</a></span>XPacketizer56_RTPMediaHeader()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XPacketizer56_RTPMediaHeader </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_packetizer56.html">XPacketizer56</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function Writes the RTP-Media Header into the VoIP ST2022-6 Register. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_packetizer56.html" title="The VoIP ST2022-6 Packetizer driver instance data. ">XPacketizer56</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="xpacketizer56__hw_8h.html#a28587e6d7339280842f2942b4dac77e3">XPacketizer56_ReadReg</a>.</p>

</div>
</div>
<a id="af872f7a0af19ac04acfae5b55ca6a5e5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af872f7a0af19ac04acfae5b55ca6a5e5">&#9670;&nbsp;</a></span>XPacketizer56_SetCallback()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XPacketizer56_SetCallback </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_packetizer56.html">XPacketizer56</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="xpacketizer56_8h.html#abf9d1385746f90dfa560788deb9a3d65">XPacketizer56_HandlerType</a>&#160;</td>
          <td class="paramname"><em>HandlerType</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>CallbackFunc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>CallbackRef</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function installs an asynchronous callback function for the given HandlerType: </p>
<pre>
HandlerType                 Callback Function Type
-------------------------   -----------------------------------------------
</pre><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the VoIP ST2022-6 Packetizer core instance. </td></tr>
    <tr><td class="paramname">HandlerType</td><td>specifies the type of handler. </td></tr>
    <tr><td class="paramname">CallbackFunc</td><td>is the address of the callback function. </td></tr>
    <tr><td class="paramname">CallbackRef</td><td>is a user data item that will be passed to the callback function when it is invoked.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if callback function installed successfully.</li>
<li>XST_INVALID_PARAM when HandlerType is invalid.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Invoking this function for a handler that already has been installed replaces it with the new handler. </dd></dl>

</div>
</div>
<a id="abb006d8aed47ede27b6f13590ca7cffa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abb006d8aed47ede27b6f13590ca7cffa">&#9670;&nbsp;</a></span>XPacketizer56_SetChannel()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XPacketizer56_SetChannel </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_packetizer56.html">XPacketizer56</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function Sets the Channel Number Information which will be added in to TUSER Master AXI4-Stream of the Module. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_packetizer56.html" title="The VoIP ST2022-6 Packetizer driver instance data. ">XPacketizer56</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="xpacketizer56__hw_8h.html#a28587e6d7339280842f2942b4dac77e3">XPacketizer56_ReadReg</a>.</p>

</div>
</div>
<a id="ac24d2370200ddf0cd2efdef54be18952"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac24d2370200ddf0cd2efdef54be18952">&#9670;&nbsp;</a></span>XPacketizer56_SetSSRC()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XPacketizer56_SetSSRC </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_packetizer56.html">XPacketizer56</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function Sets the RTP-SSRC Header. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_packetizer56.html" title="The VoIP ST2022-6 Packetizer driver instance data. ">XPacketizer56</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="xpacketizer56__hw_8h.html#afefb1382247a51b624ff07e167340b20">XPacketizer56_WriteReg</a>.</p>

</div>
</div>
<a id="a94745146086a37969cb0853f2bf0ba2f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a94745146086a37969cb0853f2bf0ba2f">&#9670;&nbsp;</a></span>XPacketizer56_VidFormat()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XPacketizer56_VidFormat </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_packetizer56.html">XPacketizer56</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function Writes the Video Format into the VoIP ST2022-6 Register. </p>
<p>This register is valid if the core is set to obtained video format from the Register space.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the <a class="el" href="struct_x_packetizer56.html" title="The VoIP ST2022-6 Packetizer driver instance data. ">XPacketizer56</a> core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="xpacketizer56__hw_8h.html#a28587e6d7339280842f2942b4dac77e3">XPacketizer56_ReadReg</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
  </ul>
</div>
</body>
</html>
